Rename AgentKit examples title#651
Conversation
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Caution Review failedPull request was closed or merged during review WalkthroughAdds seven redirects from /agentkit/frameworks/* to /agentkit/examples/*; renames an examples page; updates many AgentKit docs and templates to require exact dashboard connection names, prefer get_or_create connected-account flows, and increase tool-listing pagination to page_size=100; minor MDX generation updates. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 3/5 reviews remaining, refill in 18 minutes and 42 seconds. Comment |
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/configs/redirects.config.ts`:
- Around line 380-382: Add a redirect mapping for the legacy index path
'/agentkit/frameworks' to point to '/agentkit/examples/' alongside the existing
child-route redirects; update src/configs/redirects.config.ts near the entries
'/agentkit/frameworks/langchain' and '/agentkit/frameworks/google-adk' to
include '/agentkit/frameworks': '/agentkit/examples/' so old bookmarks or links
referenced from sidebar.config.ts still resolve to the new hub.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 3db1a128-ba68-4d75-9ebb-b620cfb699a8
📒 Files selected for processing (3)
src/configs/redirects.config.tssrc/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (11)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
src/configs/redirects.config.ts
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements
Files:
src/configs/redirects.config.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (
@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases
Files:
src/configs/redirects.config.ts
**/*.{js,ts,tsx,py,go,java}
📄 CodeRabbit inference engine (AGENTS.md)
Use exact SDK variable names: Node.js:
scalekit, Python:scalekit_client, Go:scalekitClient, Java:scalekitClient
Files:
src/configs/redirects.config.ts
**/*.{ts,js,mjs}
⚙️ CodeRabbit configuration file
**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:
- Comments that "duplicate" or restate what the code does.
- Missing comments on bug fixes, workarounds, or issue references.
- Missing inline documentation or explanatory comments.
Code comments are at the author's discretion.
Files:
src/configs/redirects.config.ts
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs...
Files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
src/content/docs/**/*.mdx
📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)
src/content/docs/**/*.mdx: In MDX documentation files,<Steps>must contain one continuous ordered list. Wrap<Steps>around a normal Markdown ordered list such as1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the1. ##,2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images,<Tabs>,<TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside<Steps>. If the content is mostly<Tabs>or other JSX-heavy blocks, use normal section headings instead of<Steps>
In MDX documentation files, when<Tabs>is used inside a step, keep<Tabs>,<TabItem>,</TabItem>, and</Tabs>consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside</Steps>
Files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
src/content/docs/**/*.{md,mdx}: Every documentation page must include frontmatter with at least:title(≤60 chars),description(≤160 chars), andsidebar.label(1-3 words)
Use H2 for major sections, H3 for subsections, and H4 only inside<Steps>; never use H1 in body content and avoid nesting beyond H4
Use numbered lists only inside<Steps>for ordered procedures; use bulleted lists for unordered information
Use bold for first mention of important terms, UI elements, and dashboard paths; use inline code for technical identifiers (variables, functions, endpoints, scopes, environment variables, file paths, placeholders)
The<Steps>component requires a single continuous ordered list with proper indentation: steps at column 0, continuation content indented with exactly 3 spaces
Use<Aside>component with atitleattribute for cautions, tips, and notes
Use<Badge>component to indicate parameter requirements in tables and inline text
Use<details>blocks at the end of pages for FAQs, common scenarios, and troubleshooting
Split content into clear sections with descriptive, sentence-style titles; include a table of contents for documents with multiple sections; keep paragraphs short and isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content; put topic words at the beginning to support fast skimming; put key takeaways and results at the top of documents
Use bullets and tables generously to structure information; bold important text to highlight key concepts and decisions
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns like 'this' or 'that' when the referent is not explicit
Maintain strict consistency in terminology, formatting, and style; do not presume the reader's state of mind or intentions; use direct, instructional language
Write more simply than you think you need to; optimize for readers new to the do...
Files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
src/content/docs/agentkit/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
Agentkit code examples live in the external repo scalekit-developers/agent-auth-examples organized as
javascript/frameworks/<framework>andpython/frameworks/<framework>; verify docs snippets match current implementations in that repo
Files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
🧠 Learnings (35)
📓 Common learnings
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 539
File: src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx:1-15
Timestamp: 2026-03-26T13:43:56.358Z
Learning: In scalekit-inc/developer-docs, the cookbook page src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx intentionally uses a title of 66 characters ("Search Scalekit docs with ref.tools in your AI coding assistant") that exceeds the standard 60-character limit. The maintainer (saif-at-scalekit) has confirmed this title should be kept as-is because it is considered fully meaningful. Do not flag this title length in future reviews.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 546
File: public/api/scalekit.scalar.json:3511-3563
Timestamp: 2026-03-29T07:52:33.367Z
Learning: In scalekit-inc/developer-docs, when ambiguity is found in generated OpenAPI under public/api/**, open an upstream issue in scalekit-inc/scalekit documenting the contract change and link back to the PR comment, then resolve the review thread after posting the upstream issue link. Do not edit generated spec files directly in this repo.
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Applied to files:
src/configs/redirects.config.tssrc/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/configs/redirects.config.tssrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-04-22T04:05:02.920Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:143-237
Timestamp: 2026-04-22T04:05:02.920Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the MCP tool calling SDK examples (`list_scoped_tools` / `execute_tool`, under the "MCP tool calling" section) only include Node.js and Python tabs because Go and Java SDK support for this functionality is not yet available. Do not require or enforce Go and Java tabs in `<Tabs syncKey="tech-stack">` blocks for MCP tool calling in bring-your-own-connector docs until those SDKs support the feature.
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-02-26T07:21:37.207Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Applied to files:
src/configs/redirects.config.tssrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-04-13T10:43:05.628Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Applied to files:
src/configs/redirects.config.tssrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-04-20T17:03:02.786Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
Applied to files:
src/configs/redirects.config.tssrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-04-01T10:25:50.208Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 567
File: src/content/docs/reference/agent-connectors/apifymcp.mdx:70-70
Timestamp: 2026-04-01T10:25:50.208Z
Learning: In `src/content/docs/reference/agent-connectors/apifymcp.mdx` (and similar agent-connector reference pages), example search terms shown inside backtick-quoted strings in parameter tables (e.g., `"google maps"`, `"instagram scraper"`) represent literal API query inputs typed by users, not references to proper nouns or product names. Do not flag lowercase casing of product names inside these code-quoted example query strings; the lowercase form is intentional to show realistic search input.
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-03-13T03:51:44.897Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Update code examples when APIs or behaviors change
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-02-26T07:18:51.377Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Applied to files:
src/content/docs/agentkit/examples/index.mdx
📚 Learning: 2026-03-16T21:02:51.181Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/expressive-code.mdc:0-0
Timestamp: 2026-03-16T21:02:51.181Z
Learning: Applies to **/*.{md,mdx} : Do not change semantics of code examples—only improve presentation and clarity when refactoring to `<Code>` components
Applied to files:
src/content/docs/agentkit/examples/index.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Ensure code examples reflect current APIs and are tested when possible
Applied to files:
src/content/docs/agentkit/examples/index.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Set appropriate sidebar labels for navigation in frontmatter
Applied to files:
src/content/docs/agentkit/examples/index.mdx
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Sidebar labels should match page title semantics but be shorter when useful
Applied to files:
src/content/docs/agentkit/examples/index.mdx
📚 Learning: 2026-01-30T18:20:07.851Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:1-6
Timestamp: 2026-01-30T18:20:07.851Z
Learning: In the scalekit-inc/developer-docs repository, MDX files under `src/content/docs/authenticate/fsa/multiapp/` do not use `order` or `tags` fields in their frontmatter. Ordering and grouping are managed centrally in `src/configs/sidebar.config.ts`.
Applied to files:
src/content/docs/agentkit/examples/index.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Set concise sidebar labels that match user vocabulary in navigation metadata
Applied to files:
src/content/docs/agentkit/examples/index.mdx
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Applied to files:
src/content/docs/agentkit/examples/index.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-03-17T16:01:50.487Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-04-27T07:13:48.244Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 628
File: src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx:59-102
Timestamp: 2026-04-27T07:13:48.244Z
Learning: In AgentKit documentation MDX files, when showing Python `execute_tool` calls, treat `connection_name` as a supported argument (along with `tool_name`, `tool_input`, `identifier`, and `connected_account_id`). Do not flag `connection_name` as an invalid/unsupported parameter in these Python examples.
Applied to files:
src/content/docs/agentkit/examples/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use CardGrid, Card, and LinkCard components for organized content presentation in MDX documentation
Applied to files:
src/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Use CardGrid, Card, and LinkCard components for hubs and navigation pages in MDX documentation
Applied to files:
src/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-03-09T10:26:58.650Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 471
File: src/content/docs/dev-kit/ai-assisted-development/context7.mdx:9-10
Timestamp: 2026-03-09T10:26:58.650Z
Learning: In scalekit-inc/developer-docs, standalone utility/reference pages under src/content/docs/dev-kit/ that are not part of a sequential product journey (e.g., context7.mdx under dev-kit/ai-assisted-development/) may intentionally use `prev: false` and `next: false` in frontmatter. Do not flag the absence of prev/next navigation or a "what's next" signal on such pages.
Applied to files:
src/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-03-12T16:28:42.817Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:42.817Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) for external links is acceptable and intentional. Do not flag the absence of target="_blank" and rel="noopener" attributes in these agent-connector setup template files. This follows the established pattern across all connector templates in this directory.
Applied to files:
src/content/docs/agentkit/tools/agent-tools-quickstart.mdx
📚 Learning: 2026-03-31T16:14:24.575Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: public/AGENTS.md:0-0
Timestamp: 2026-03-31T16:14:24.575Z
Learning: Use Scalekit official plugin for AI coding agents (Claude Code, GitHub Copilot, Codex, or Skills CLI/Windsurf/Cline) to reduce hallucinations and improve code generation accuracy
Applied to files:
src/content/docs/agentkit/tools/agent-tools-quickstart.mdx
🔇 Additional comments (2)
src/content/docs/agentkit/examples/index.mdx (1)
2-5: Title and sidebar rename looks good.This rename is consistent with the page purpose and improves discoverability in navigation.
src/content/docs/agentkit/tools/agent-tools-quickstart.mdx (1)
240-244: Updated Next steps links are correct.The new targets align with the
/agentkit/examples/*/route scheme and keep quickstart navigation consistent.
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/configs/redirects.config.ts`:
- Around line 380-384: Add redirects for the migrated framework pages so legacy
URLs under '/agentkit/frameworks/*' map to '/agentkit/examples/*': update the
redirects configuration (where '/agentkit/frameworks' and entries like
'/agentkit/frameworks/langchain' and '/agentkit/frameworks/google-adk' are
defined) to either add explicit mappings for '/agentkit/frameworks/anthropic',
'/agentkit/frameworks/mastra', '/agentkit/frameworks/openai', and
'/agentkit/frameworks/vercel-ai' pointing to their '/agentkit/examples/...'
counterparts, or implement a wildcard redirect (e.g., '/agentkit/frameworks/* →
/agentkit/examples/:splat') in public/_redirects to cover all migrated
frameworks.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 3046d0f6-eb2d-40e8-a6df-980a517e7766
📒 Files selected for processing (1)
src/configs/redirects.config.ts
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
src/configs/redirects.config.ts
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements
Files:
src/configs/redirects.config.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (
@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases
Files:
src/configs/redirects.config.ts
**/*.{js,ts,tsx,py,go,java}
📄 CodeRabbit inference engine (AGENTS.md)
Use exact SDK variable names: Node.js:
scalekit, Python:scalekit_client, Go:scalekitClient, Java:scalekitClient
Files:
src/configs/redirects.config.ts
**/*.{ts,js,mjs}
⚙️ CodeRabbit configuration file
**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:
- Comments that "duplicate" or restate what the code does.
- Missing comments on bug fixes, workarounds, or issue references.
- Missing inline documentation or explanatory comments.
Code comments are at the author's discretion.
Files:
src/configs/redirects.config.ts
🧠 Learnings (11)
📓 Common learnings
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Update code examples when APIs or behaviors change
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Ensure code examples reflect current APIs and are tested when possible
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Ensure code examples reflect current APIs and are tested when possible
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Update code examples when APIs or behaviors change
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-02-26T07:21:37.207Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-03-20T02:32:40.836Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 514
File: src/content/docs/agent-auth/quickstart.mdx:82-82
Timestamp: 2026-03-20T02:32:40.836Z
Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-04-22T04:05:02.920Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:143-237
Timestamp: 2026-04-22T04:05:02.920Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the MCP tool calling SDK examples (`list_scoped_tools` / `execute_tool`, under the "MCP tool calling" section) only include Node.js and Python tabs because Go and Java SDK support for this functionality is not yet available. Do not require or enforce Go and Java tabs in `<Tabs syncKey="tech-stack">` blocks for MCP tool calling in bring-your-own-connector docs until those SDKs support the feature.
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-04-13T10:43:05.628Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-03-13T03:51:44.897Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Applied to files:
src/configs/redirects.config.ts
📚 Learning: 2026-04-20T17:03:02.786Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
Applied to files:
src/configs/redirects.config.ts
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/authenticate/set-up-scalekit.mdx`:
- Around line 307-349: Update the four code fences in set-up-scalekit.mdx to
include title attributes: add title="Terminal" to the two bash blocks containing
the "claude mcp add --transport http scalekit https://mcp.scalekit.com/" and
"codex mcp add scalekit --url https://mcp.scalekit.com/" commands, add
title="~/.cursor/mcp.json" showLineNumbers=false to the JSON block with the
"mcpServers" object (the snippet that edits ~/.cursor/mcp.json), and add
title="opencode.json" showLineNumbers=false to the JSON block that defines the
"mcp" → "scalekit" entry; ensure each opening triple-backtick fence is updated
(no other content changes).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 1ae21f1d-fcbb-4702-adf2-c3e13e5545e9
📒 Files selected for processing (1)
src/content/docs/authenticate/set-up-scalekit.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (6)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/content/docs/authenticate/set-up-scalekit.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs...
Files:
src/content/docs/authenticate/set-up-scalekit.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/content/docs/authenticate/set-up-scalekit.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/content/docs/authenticate/set-up-scalekit.mdx
src/content/docs/**/*.mdx
📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)
src/content/docs/**/*.mdx: In MDX documentation files,<Steps>must contain one continuous ordered list. Wrap<Steps>around a normal Markdown ordered list such as1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the1. ##,2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images,<Tabs>,<TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside<Steps>. If the content is mostly<Tabs>or other JSX-heavy blocks, use normal section headings instead of<Steps>
In MDX documentation files, when<Tabs>is used inside a step, keep<Tabs>,<TabItem>,</TabItem>, and</Tabs>consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside</Steps>
Files:
src/content/docs/authenticate/set-up-scalekit.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
src/content/docs/**/*.{md,mdx}: Every documentation page must include frontmatter with at least:title(≤60 chars),description(≤160 chars), andsidebar.label(1-3 words)
Use H2 for major sections, H3 for subsections, and H4 only inside<Steps>; never use H1 in body content and avoid nesting beyond H4
Use numbered lists only inside<Steps>for ordered procedures; use bulleted lists for unordered information
Use bold for first mention of important terms, UI elements, and dashboard paths; use inline code for technical identifiers (variables, functions, endpoints, scopes, environment variables, file paths, placeholders)
The<Steps>component requires a single continuous ordered list with proper indentation: steps at column 0, continuation content indented with exactly 3 spaces
Use<Aside>component with atitleattribute for cautions, tips, and notes
Use<Badge>component to indicate parameter requirements in tables and inline text
Use<details>blocks at the end of pages for FAQs, common scenarios, and troubleshooting
Split content into clear sections with descriptive, sentence-style titles; include a table of contents for documents with multiple sections; keep paragraphs short and isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content; put topic words at the beginning to support fast skimming; put key takeaways and results at the top of documents
Use bullets and tables generously to structure information; bold important text to highlight key concepts and decisions
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns like 'this' or 'that' when the referent is not explicit
Maintain strict consistency in terminology, formatting, and style; do not presume the reader's state of mind or intentions; use direct, instructional language
Write more simply than you think you need to; optimize for readers new to the do...
Files:
src/content/docs/authenticate/set-up-scalekit.mdx
src/content/docs/authenticate/**/*.mdx
⚙️ CodeRabbit configuration file
src/content/docs/authenticate/**/*.mdx: This page lives in the primary authentication section.
- If it's a quickstart or step-based guide, it MUST use
<Steps>.- Auth method pages (passwordless, social, SSO, passkeys) MUST include
a brief "when to use this" section before the implementation steps.- Any reference to tokens (idToken, accessToken, refreshToken) MUST
clarify: what it contains, its lifetime, and how to use it securely.- The FSA quickstart (
authenticate/fsa/quickstart.mdx) is the
canonical entry point — no other page should duplicate its 5-step
install→redirect→callback→session→logout structure.
Files:
src/content/docs/authenticate/set-up-scalekit.mdx
🧠 Learnings (25)
📓 Common learnings
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 539
File: src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx:1-15
Timestamp: 2026-03-26T13:43:56.358Z
Learning: In scalekit-inc/developer-docs, the cookbook page src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx intentionally uses a title of 66 characters ("Search Scalekit docs with ref.tools in your AI coding assistant") that exceeds the standard 60-character limit. The maintainer (saif-at-scalekit) has confirmed this title should be kept as-is because it is considered fully meaningful. Do not flag this title length in future reviews.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 514
File: src/content/docs/agent-auth/quickstart.mdx:82-82
Timestamp: 2026-03-20T02:32:40.836Z
Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:42.817Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) for external links is acceptable and intentional. Do not flag the absence of target="_blank" and rel="noopener" attributes in these agent-connector setup template files. This follows the established pattern across all connector templates in this directory.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Update code examples when APIs or behaviors change
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Ensure code examples reflect current APIs and are tested when possible
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
📚 Learning: 2026-03-25T10:15:02.544Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 529
File: src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx:188-190
Timestamp: 2026-03-25T10:15:02.544Z
Learning: In scalekit-inc/developer-docs, the Aside note in `src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx` warning that ChatGPT's beta MCP connector "may not work correctly" and "does not fully implement the MCP specification" is intentional. Real-world developers have reported re-auth loops and inconsistent streamable HTTP behaviour with ChatGPT compared to Claude, even though OpenAI's marketing describes it as "full MCP support". Do not flag or suggest removing this compatibility warning in future reviews.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-04-22T09:59:00.346Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-03-13T04:24:59.653Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-02-02T05:55:51.251Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Include configuration comments in code examples: '// Get the signing secret from Scalekit dashboard > Interceptors tab'
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-03-25T16:04:34.150Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 532
File: astro.config.mjs:302-302
Timestamp: 2026-03-25T16:04:34.150Z
Learning: In scalekit-inc/developer-docs, the D2 diagram generation behavior (skipped when the `NETLIFY` env var is set via `netlify dev`) is already documented in CONTRIBUTING.md. Do not flag missing documentation for this behavior in `astro.config.mjs`.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use consistent SDK variable naming: Node.js='scalekit', Python='scalekit_client', Go='scalekitClient', Java='scalekitClient'
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-03-20T02:32:40.836Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 514
File: src/content/docs/agent-auth/quickstart.mdx:82-82
Timestamp: 2026-03-20T02:32:40.836Z
Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-03-31T16:14:24.575Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: public/AGENTS.md:0-0
Timestamp: 2026-03-31T16:14:24.575Z
Learning: Use Scalekit official plugin for AI coding agents (Claude Code, GitHub Copilot, Codex, or Skills CLI/Windsurf/Cline) to reduce hallucinations and improve code generation accuracy
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Product-based documentation (MCP Auth, Agent Auth, Full Stack Auth, Modular SCIM, Modular SSO) must follow a journey-focused approach representing a developer's journey toward implementing authentication
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Product-based documentation (MCP Auth, Agent Auth, Full Stack Auth, Modular SCIM, Modular SSO) MUST follow a journey-focused approach. Each product represents a developer's journey toward implementing authentication in their projects
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-03-17T16:01:50.487Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.
Applied to files:
src/content/docs/authenticate/set-up-scalekit.mdx
🔇 Additional comments (2)
src/content/docs/authenticate/set-up-scalekit.mdx (2)
290-301: Good simplification of MCP setup framingThe revised copy is clearer and correctly funnels users to the full MCP server guide for broader host coverage.
360-360: Nice host-coverage note updateThe note cleanly redirects users of less-common hosts without overloading this page.
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/content/docs/agentkit/connected-accounts.mdx (1)
49-55:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winBind the connected account before reusing it in the follow-up example.
connectedAccountis referenced in the inactive-account snippet, but the status-check example never assigns it. That makes the Node.js sample non-copy-pastable.Suggested fix
const response = await actions.getOrCreateConnectedAccount({ connectionName: 'gmail', identifier: 'user_123', }); -console.log('Status:', response.connectedAccount?.status); +const connectedAccount = response.connectedAccount; +console.log('Status:', connectedAccount?.status);Also applies to: 81-92
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/agentkit/connected-accounts.mdx` around lines 49 - 55, The status-check snippet references connectedAccount but never assigns it; modify the example around actions.getOrCreateConnectedAccount to capture and reuse the created account (e.g., const { connectedAccount } = await actions.getOrCreateConnectedAccount(...)) before calling console.log('Status:', connectedAccount?.status), and apply the same fix to the later example (lines 81-92/inactive-account snippet) so both samples are copy-pastable and consistently use the connectedAccount variable returned from getOrCreateConnectedAccount.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@src/content/docs/agentkit/connected-accounts.mdx`:
- Around line 49-55: The status-check snippet references connectedAccount but
never assigns it; modify the example around actions.getOrCreateConnectedAccount
to capture and reuse the created account (e.g., const { connectedAccount } =
await actions.getOrCreateConnectedAccount(...)) before calling
console.log('Status:', connectedAccount?.status), and apply the same fix to the
later example (lines 81-92/inactive-account snippet) so both samples are
copy-pastable and consistently use the connectedAccount variable returned from
getOrCreateConnectedAccount.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 882410ab-0eb7-41ba-b3c0-ff5267bb0fd8
📒 Files selected for processing (3)
src/content/docs/agentkit/connected-accounts.mdxsrc/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (7)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs...
Files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
src/content/docs/**/*.mdx
📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)
src/content/docs/**/*.mdx: In MDX documentation files,<Steps>must contain one continuous ordered list. Wrap<Steps>around a normal Markdown ordered list such as1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the1. ##,2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images,<Tabs>,<TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside<Steps>. If the content is mostly<Tabs>or other JSX-heavy blocks, use normal section headings instead of<Steps>
In MDX documentation files, when<Tabs>is used inside a step, keep<Tabs>,<TabItem>,</TabItem>, and</Tabs>consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside</Steps>
Files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
src/content/docs/**/*.{md,mdx}: Every documentation page must include frontmatter with at least:title(≤60 chars),description(≤160 chars), andsidebar.label(1-3 words)
Use H2 for major sections, H3 for subsections, and H4 only inside<Steps>; never use H1 in body content and avoid nesting beyond H4
Use numbered lists only inside<Steps>for ordered procedures; use bulleted lists for unordered information
Use bold for first mention of important terms, UI elements, and dashboard paths; use inline code for technical identifiers (variables, functions, endpoints, scopes, environment variables, file paths, placeholders)
The<Steps>component requires a single continuous ordered list with proper indentation: steps at column 0, continuation content indented with exactly 3 spaces
Use<Aside>component with atitleattribute for cautions, tips, and notes
Use<Badge>component to indicate parameter requirements in tables and inline text
Use<details>blocks at the end of pages for FAQs, common scenarios, and troubleshooting
Split content into clear sections with descriptive, sentence-style titles; include a table of contents for documents with multiple sections; keep paragraphs short and isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content; put topic words at the beginning to support fast skimming; put key takeaways and results at the top of documents
Use bullets and tables generously to structure information; bold important text to highlight key concepts and decisions
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns like 'this' or 'that' when the referent is not explicit
Maintain strict consistency in terminology, formatting, and style; do not presume the reader's state of mind or intentions; use direct, instructional language
Write more simply than you think you need to; optimize for readers new to the do...
Files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
src/content/docs/agentkit/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
Agentkit code examples live in the external repo scalekit-developers/agent-auth-examples organized as
javascript/frameworks/<framework>andpython/frameworks/<framework>; verify docs snippets match current implementations in that repo
Files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/agentkit/connected-accounts.mdx
src/content/docs/cookbooks/**/*.mdx
⚙️ CodeRabbit configuration file
src/content/docs/cookbooks/**/*.mdx: This file is a Scalekit cookbook: a standalone recipe under the
starlight-blog integration (prefix: cookbooksin astro.config.mjs).
Apply global MDX voice, style, links, and accessibility rules, but use
these cookbook-specific expectations:Overrides to global MDX checks
- Do NOT require
sidebar.order— ordering follows the blog plugin and
publication metadata, not sidebar.config.ts journey slots.- Do NOT require
prev/nextfrontmatter — cookbooks are not a
sequential product journey; cross-links and related docs are enough.tableOfContentsis optional — enable it when the post has many H2s.Frontmatter
titleanddescriptionfollow the same length and clarity rules as
global MDX.- Prefer
sidebar.labelfor navigation consistency; if absent, do not
treat it as a hard failure (older cookbooks may omit it).date,tags,authors,excerpt, andfeaturedare normal for
cookbooks — verify tags match the topic (e.g. MCP, SSO, FSA).Code examples
- Require all four SDK tabs (Node.js, Python, Go, Java) ONLY when the
snippet demonstrates Scalekit client SDK usage. For MCP setup, CLI,
shell, framework-only (e.g. Next.js), or IDE configuration recipes,
use the tabs or single-language blocks that fit the task. Do not
demand four SDK languages for bash, JSON, env files, or non-SDK code.- Minimal examples (single command, config block) do not need both
success and error paths unless the recipe is explicitly about errors.- Flag real-looking API keys or secrets — use placeholders such as
YOUR_API_KEYorYOUR_CLIENT_SECRET.
<Steps>(overrides global "how-to MUST use Steps")
- Do NOT require
<Steps>on cookbooks. The global rule targets journey
how-to pages; a cookbook may use H2 sections,<Tabs>, or prose.- Do NOT flag "missing Steps" when the procedure is already clear.
- If
<Steps>is used,<Tabs>or other blocks MAY appear after
</Steps>(e.g. per–IDE ...
Files:
src/content/docs/cookbooks/daily-briefing-agent.mdx
🧠 Learnings (23)
📓 Common learnings
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 539
File: src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx:1-15
Timestamp: 2026-03-26T13:43:56.358Z
Learning: In scalekit-inc/developer-docs, the cookbook page src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx intentionally uses a title of 66 characters ("Search Scalekit docs with ref.tools in your AI coding assistant") that exceeds the standard 60-character limit. The maintainer (saif-at-scalekit) has confirmed this title should be kept as-is because it is considered fully meaningful. Do not flag this title length in future reviews.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 514
File: src/content/docs/agent-auth/quickstart.mdx:82-82
Timestamp: 2026-03-20T02:32:40.836Z
Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Keep documentation accurate and up-to-date with product changes, updating examples when APIs change
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 529
File: src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx:188-190
Timestamp: 2026-03-25T10:15:02.544Z
Learning: In scalekit-inc/developer-docs, the Aside note in `src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx` warning that ChatGPT's beta MCP connector "may not work correctly" and "does not fully implement the MCP specification" is intentional. Real-world developers have reported re-auth loops and inconsistent streamable HTTP behaviour with ChatGPT compared to Claude, even though OpenAI's marketing describes it as "full MCP support". Do not flag or suggest removing this compatibility warning in future reviews.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 646
File: src/content/docs/agentkit/connectors/salesforce.mdx:71-132
Timestamp: 2026-04-28T14:33:57.957Z
Learning: In `src/content/docs/agentkit/connectors/salesforce.mdx`, the "Metadata API SOAP proxy calls" section uses Python-only code examples because the Salesforce SOAP proxy feature is currently only available in the Python SDK. Do not require or enforce Node.js, Go, and Java tabs in `<Tabs syncKey="tech-stack">` blocks for this section until those SDKs support the Salesforce SOAP proxy feature.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 476
File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99
Timestamp: 2026-03-10T12:26:38.439Z
Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.
📚 Learning: 2026-04-27T07:13:48.244Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 628
File: src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx:59-102
Timestamp: 2026-04-27T07:13:48.244Z
Learning: In AgentKit documentation MDX files, when showing Python `execute_tool` calls, treat `connection_name` as a supported argument (along with `tool_name`, `tool_input`, `identifier`, and `connected_account_id`). Do not flag `connection_name` as an invalid/unsupported parameter in these Python examples.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-03-12T05:02:13.454Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 487
File: src/content/docs/agent-auth/connections.mdx:0-0
Timestamp: 2026-03-12T05:02:13.454Z
Learning: In `src/content/docs/agent-auth/connections.mdx` (and Agent Auth docs in general), custom authentication (username/password/bearer-token flows) is intentionally out of scope for the current Agent Auth release. Do not flag the absence of custom authentication documentation in Agent Auth connection-type sections.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-03-12T05:02:13.454Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 487
File: src/content/docs/agent-auth/connections.mdx:0-0
Timestamp: 2026-03-12T05:02:13.454Z
Learning: In `src/content/docs/agent-auth/connections.mdx` (and Agent Auth docs generally), custom authentication (username/password/bearer-token flows) is intentionally out of scope for the current Agent Auth release. Do not flag the absence of custom authentication connection type documentation in Agent Auth connection-type sections.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-04-01T08:35:26.973Z
Learnt from: srinivaskarre-sk
Repo: scalekit-inc/developer-docs PR: 566
File: src/content/docs/agent-auth/user-verification.mdx:55-117
Timestamp: 2026-04-01T08:35:26.973Z
Learning: In `src/content/docs/agent-auth/user-verification.mdx` and Agent Auth connected accounts documentation (src/content/docs/agent-auth/**/*.mdx), only Python and Node.js SDK support is currently available for Agent Auth features (including connected accounts magic link creation and user verification). Do not require or enforce Go and Java tabs in `<Tabs syncKey="tech-stack">` blocks for these files. Add Go and Java TabItems once those SDKs support Agent Auth/connected account features.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-03-17T16:01:50.487Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.
Applied to files:
src/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-03-27T16:55:31.608Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 544
File: src/content/docs/cookbooks/daily-briefing-agent.mdx:0-0
Timestamp: 2026-03-27T16:55:31.608Z
Learning: In `src/content/docs/cookbooks/daily-briefing-agent.mdx`, the `ensureConnected` (TypeScript) and `ensure_connected` (Python) functions intentionally use a single `if` check (not a `while` loop with re-validation) after the OAuth prompt. This is deliberate, well-tested example code reflecting the actual repo pattern. Do not suggest adding retry loops or post-prompt status re-validation in future reviews of this file.
Applied to files:
src/content/docs/cookbooks/daily-briefing-agent.mdxsrc/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-03-26T13:43:49.940Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 539
File: src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx:1-15
Timestamp: 2026-03-26T13:43:49.940Z
Learning: In scalekit-inc/developer-docs, cookbook pages under `src/content/docs/cookbooks/` use directory-based auto-generation for the sidebar (configured in `src/configs/sidebar.config.ts` with routes like `/cookbooks` and `/cookbooks/**/*`). For files in this directory, do not require or flag missing `sidebar.label` in the MDX frontmatter.
Applied to files:
src/content/docs/cookbooks/daily-briefing-agent.mdx
📚 Learning: 2026-03-20T02:32:40.836Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 514
File: src/content/docs/agent-auth/quickstart.mdx:82-82
Timestamp: 2026-03-20T02:32:40.836Z
Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
Applied to files:
src/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-04-22T09:59:00.346Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Applied to files:
src/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Applied to files:
src/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-04-01T14:52:05.113Z
Learnt from: srinivaskarre-sk
Repo: scalekit-inc/developer-docs PR: 566
File: src/content/docs/agent-auth/user-verification.mdx:0-0
Timestamp: 2026-04-01T14:52:05.113Z
Learning: In `src/content/docs/agent-auth/user-verification.mdx`, the magic link creation and verify API code snippets (Python and Node.js) intentionally omit try/catch and try/except error handling to keep the step-by-step guide easy to follow. Error semantics (state mismatch, verification failure, CSRF protection) are covered in the surrounding prose and Aside components. Do not flag the absence of error paths in these specific snippets in future reviews.
Applied to files:
src/content/docs/agentkit/connected-accounts.mdx
📚 Learning: 2026-03-03T13:35:56.400Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 455
File: src/content/docs/reference/agent-connectors/asana.mdx:94-173
Timestamp: 2026-03-03T13:35:56.400Z
Learning: For Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), currently only Python SDK support is available for Agent Actions/Agent Connectors. Do not require or enforce the multi-language SDK code examples (Node.js, Python, Go, Java) guideline for these connector docs until SDK support is ready in other languages. The Node.js, Go, and Java examples can be added once the respective SDKs support Agent Actions features.
Applied to files:
src/content/docs/agentkit/connected-accounts.mdx
🔇 Additional comments (4)
src/content/docs/agentkit/connected-accounts.mdx (2)
34-34: Good clarification on the default flow.This matches the updated
get_or_create_connected_accountguidance and makes the intended usage clearer.
132-132: Good clarification here as well.The updated guidance correctly steers first-time and general flows to
get_or_create_connected_accountwhile keepingget_connected_accountfor known existing accounts.src/content/docs/agentkit/sdks/python/index.mdx (1)
132-132: This guidance looks right.The note cleanly distinguishes the credential-payload use case for
get_connected_accountfrom the safer default ofget_or_create_connected_account.src/content/docs/cookbooks/daily-briefing-agent.mdx (1)
277-290: This token helper update looks good.Using
get_or_create_connected_accounthere avoids the not-found path, and the active-status check keeps token extraction limited to valid connected accounts.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/agentkit/quickstart.mdx`:
- Line 156: The failure message only references connection_name but the Node.js
examples use connectionName; update the explanatory sentence in quickstart.mdx
to mention both parameter names (connection_name and connectionName) so readers
can match either naming convention in AgentKit and the Node.js SDK, ensuring the
failure condition text includes both symbols exactly as used elsewhere in the
docs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 24087095-b13e-40cb-b45c-104fb5031427
📒 Files selected for processing (4)
src/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (6)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs...
Files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
src/content/docs/**/*.mdx
📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)
src/content/docs/**/*.mdx: In MDX documentation files,<Steps>must contain one continuous ordered list. Wrap<Steps>around a normal Markdown ordered list such as1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the1. ##,2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images,<Tabs>,<TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside<Steps>. If the content is mostly<Tabs>or other JSX-heavy blocks, use normal section headings instead of<Steps>
In MDX documentation files, when<Tabs>is used inside a step, keep<Tabs>,<TabItem>,</TabItem>, and</Tabs>consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside</Steps>
Files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
src/content/docs/**/*.{md,mdx}: Every documentation page must include frontmatter with at least:title(≤60 chars),description(≤160 chars), andsidebar.label(1-3 words)
Use H2 for major sections, H3 for subsections, and H4 only inside<Steps>; never use H1 in body content and avoid nesting beyond H4
Use numbered lists only inside<Steps>for ordered procedures; use bulleted lists for unordered information
Use bold for first mention of important terms, UI elements, and dashboard paths; use inline code for technical identifiers (variables, functions, endpoints, scopes, environment variables, file paths, placeholders)
The<Steps>component requires a single continuous ordered list with proper indentation: steps at column 0, continuation content indented with exactly 3 spaces
Use<Aside>component with atitleattribute for cautions, tips, and notes
Use<Badge>component to indicate parameter requirements in tables and inline text
Use<details>blocks at the end of pages for FAQs, common scenarios, and troubleshooting
Split content into clear sections with descriptive, sentence-style titles; include a table of contents for documents with multiple sections; keep paragraphs short and isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content; put topic words at the beginning to support fast skimming; put key takeaways and results at the top of documents
Use bullets and tables generously to structure information; bold important text to highlight key concepts and decisions
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns like 'this' or 'that' when the referent is not explicit
Maintain strict consistency in terminology, formatting, and style; do not presume the reader's state of mind or intentions; use direct, instructional language
Write more simply than you think you need to; optimize for readers new to the do...
Files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
src/content/docs/agentkit/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
Agentkit code examples live in the external repo scalekit-developers/agent-auth-examples organized as
javascript/frameworks/<framework>andpython/frameworks/<framework>; verify docs snippets match current implementations in that repo
Files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
🧠 Learnings (48)
📓 Common learnings
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 514
File: src/content/docs/agent-auth/quickstart.mdx:82-82
Timestamp: 2026-03-20T02:32:40.836Z
Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 539
File: src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx:1-15
Timestamp: 2026-03-26T13:43:56.358Z
Learning: In scalekit-inc/developer-docs, the cookbook page src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx intentionally uses a title of 66 characters ("Search Scalekit docs with ref.tools in your AI coding assistant") that exceeds the standard 60-character limit. The maintainer (saif-at-scalekit) has confirmed this title should be kept as-is because it is considered fully meaningful. Do not flag this title length in future reviews.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 476
File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99
Timestamp: 2026-03-10T12:26:38.439Z
Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 529
File: src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx:188-190
Timestamp: 2026-03-25T10:15:02.544Z
Learning: In scalekit-inc/developer-docs, the Aside note in `src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx` warning that ChatGPT's beta MCP connector "may not work correctly" and "does not fully implement the MCP specification" is intentional. Real-world developers have reported re-auth loops and inconsistent streamable HTTP behaviour with ChatGPT compared to Claude, even though OpenAI's marketing describes it as "full MCP support". Do not flag or suggest removing this compatibility warning in future reviews.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 546
File: public/api/scalekit.scalar.json:3511-3563
Timestamp: 2026-03-29T07:52:33.367Z
Learning: In scalekit-inc/developer-docs, when ambiguity is found in generated OpenAPI under public/api/**, open an upstream issue in scalekit-inc/scalekit documenting the contract change and link back to the PR comment, then resolve the review thread after posting the upstream issue link. Do not edit generated spec files directly in this repo.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Keep documentation accurate and up-to-date with product changes, updating examples when APIs change
📚 Learning: 2026-02-26T07:21:37.207Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-04-27T07:13:48.244Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 628
File: src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx:59-102
Timestamp: 2026-04-27T07:13:48.244Z
Learning: In AgentKit documentation MDX files, when showing Python `execute_tool` calls, treat `connection_name` as a supported argument (along with `tool_name`, `tool_input`, `identifier`, and `connected_account_id`). Do not flag `connection_name` as an invalid/unsupported parameter in these Python examples.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-04-13T14:22:37.194Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 591
File: src/content/docs/reference/agent-connectors/calendly.mdx:47-47
Timestamp: 2026-04-13T14:22:37.194Z
Learning: In `src/content/docs/reference/agent-connectors/` MDX files (agent-connector reference pages, e.g., calendly.mdx), the `title` attribute on `<Aside>` components is not required. Do not flag missing `title` props on `<Aside>` components in files under this directory. This is a deliberate exception to the global rule requiring `title` on all `<Aside>` components.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdx
📚 Learning: 2026-04-28T14:43:55.084Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 646
File: src/content/docs/agentkit/connectors/salesforce.mdx:96-112
Timestamp: 2026-04-28T14:43:55.084Z
Learning: In `src/content/docs/agentkit/connectors/salesforce.mdx`, the three Python code snippets under the "Metadata API SOAP proxy calls" section (Steps 1–3) are intentionally illustrative/guiding code. Do not require try/except error handling in these snippets; customers are expected to add error handling appropriate to their own use case. This applies alongside the existing guidance that no `title=` attribute is needed on these code blocks.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdx
📚 Learning: 2026-02-26T07:22:55.583Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141
Timestamp: 2026-02-26T07:22:55.583Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, the parameter tables (showing tool properties) are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Any table format corrections must be made in the generation script, not by manually editing the generated MDX files. The script should be updated to output the required "Name | Type | Required | Description" four-column table format per coding guidelines.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdx
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-31T16:14:24.575Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: public/AGENTS.md:0-0
Timestamp: 2026-03-31T16:14:24.575Z
Learning: Never hard-code secrets: `SCALEKIT_CLIENT_ID`, `SCALEKIT_CLIENT_SECRET`, and `SCALEKIT_ENV_URL` must be loaded from environment variables
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-17T16:01:50.487Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.
Applied to files:
src/content/docs/agentkit/connectors/googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-12T16:29:08.626Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-onenote.mdx:12-12
Timestamp: 2026-03-12T16:29:08.626Z
Learning: In files matching src/components/templates/agent-connectors/_setup-*.mdx, permit and reflect the branding 'Azure Active Directory' (AAD) as intentional. Do not flag or update these agent-connectors setup templates for references to 'Microsoft Entra ID'. This exception applies only to these setup template files; maintain standard branding elsewhere according to project guidelines.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdx
📚 Learning: 2026-03-12T16:28:37.168Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:37.168Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, external links should not be flagged for missing target="_blank" and rel="noopener". Plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) is acceptable and intentional in these agent-connector setup templates, following the established pattern across all connector templates in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdx
📚 Learning: 2026-04-13T10:43:05.628Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdx
📚 Learning: 2026-04-27T07:13:50.465Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 628
File: src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx:59-102
Timestamp: 2026-04-27T07:13:50.465Z
Learning: In `src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx`, the Python SDK's `execute_tool` function accepts `connection_name` as a valid parameter (in addition to `tool_name`, `tool_input`, `identifier`, and `connected_account_id`). Do not flag `connection_name` as an invalid or unsupported parameter in Python `execute_tool` calls in AgentKit documentation.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-04-20T17:03:02.786Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-03-10T10:37:47.033Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:47.033Z
Learning: In src/components/templates/agent-connectors/**/*.mdx, it is acceptable to reuse a single shared redirect URI screenshot (use-own-credentials-redirect-uri.png) across multiple steps within the same connector file, even if different UIs are shown. Do not flag this reuse as an issue; ensure this behavior is intentional and documented for reviewers.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-03-12T16:26:39.422Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:39.422Z
Learning: In agent-connectors MDX templates, it is acceptable to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., oauth-web-app.png, add-redirect-uri.png) across different Google-service connector templates (e.g., _setup-bigquery.mdx, _setup-google-ads.mdx). Do not flag cross-connector image path reuse within Google service connectors as an issue. This guideline applies to all files in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-04-01T10:25:50.208Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 567
File: src/content/docs/reference/agent-connectors/apifymcp.mdx:70-70
Timestamp: 2026-04-01T10:25:50.208Z
Learning: In `src/content/docs/reference/agent-connectors/apifymcp.mdx` (and similar agent-connector reference pages), example search terms shown inside backtick-quoted strings in parameter tables (e.g., `"google maps"`, `"instagram scraper"`) represent literal API query inputs typed by users, not references to proper nouns or product names. Do not flag lowercase casing of product names inside these code-quoted example query strings; the lowercase form is intentional to show realistic search input.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdx
📚 Learning: 2026-03-10T10:38:27.783Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:27.783Z
Learning: In all MDX templates under src/components/templates/agent-connectors, the pattern uses empty alt text (e.g., ![]()) for redirect URI screenshots like use-own-credentials-redirect-uri.png. This is intentional; reviews should not flag missing alt text for these images in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-03-10T10:38:30.012Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-clickup.mdx:17-17
Timestamp: 2026-03-10T10:38:30.012Z
Learning: In the repository's agent-connectors setup template files (src/components/templates/agent-connectors/_setup-*.mdx), the pattern for redirect URI screenshot images is to use empty alt text (![]()). Do not flag missing alt text for these specific Markdown image syntaxes in the agent connector setup template files. This guidance applies only to files matching this setup-*.mdx naming pattern; other templates should continue to enforce standard alt text practices.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecalendar.mdx
📚 Learning: 2026-04-22T09:59:00.346Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-25T15:59:47.933Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/components/templates/agent-connectors/_usage-granolamcp.mdx:18-48
Timestamp: 2026-03-25T15:59:47.933Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, the code snippets are intentionally directional/illustrative and are meant to demonstrate the expected call sequence, not production-ready runnable code. When reviewing these files, do not flag missing `try/except` (Python) or `try/catch` (JS/TS) error handling solely because the snippet omits it—focus on whether the call sequence/pattern is conveyed clearly.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-04-01T08:35:26.973Z
Learnt from: srinivaskarre-sk
Repo: scalekit-inc/developer-docs PR: 566
File: src/content/docs/agent-auth/user-verification.mdx:55-117
Timestamp: 2026-04-01T08:35:26.973Z
Learning: In `src/content/docs/agent-auth/user-verification.mdx` and Agent Auth connected accounts documentation (src/content/docs/agent-auth/**/*.mdx), only Python and Node.js SDK support is currently available for Agent Auth features (including connected accounts magic link creation and user verification). Do not require or enforce Go and Java tabs in `<Tabs syncKey="tech-stack">` blocks for these files. Add Go and Java TabItems once those SDKs support Agent Auth/connected account features.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-04-13T10:43:03.024Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:03.024Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, keep the trailing `## Scalekit Tools` heading at the end of each template. Do not flag it as empty or as a duplicate heading in future reviews for these files, since it is an intentional structural anchor used by the parent connector reference page to append the tool-list section beneath the proxy API examples.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-04-28T14:33:57.957Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 646
File: src/content/docs/agentkit/connectors/salesforce.mdx:71-132
Timestamp: 2026-04-28T14:33:57.957Z
Learning: In `src/content/docs/agentkit/connectors/salesforce.mdx`, the "Metadata API SOAP proxy calls" section uses Python-only code examples because the Salesforce SOAP proxy feature is currently only available in the Python SDK. Do not require or enforce Node.js, Go, and Java tabs in `<Tabs syncKey="tech-stack">` blocks for this section until those SDKs support the Salesforce SOAP proxy feature.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-03-20T02:32:40.836Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 514
File: src/content/docs/agent-auth/quickstart.mdx:82-82
Timestamp: 2026-03-20T02:32:40.836Z
Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Use Tabs/TabItem components for multi-language or multi-framework examples in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Tabs components within Steps must be indented with 3 spaces, TabItem at same level as parent Tabs, code blocks properly indented within TabItem
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to **/*.{md,mdx} : Use `<Tabs syncKey="tech-stack">` format for multi-language SDK samples with TabItem labels for each language
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : When `<Tabs>` appears inside a `<Steps>` step, keep the entire tabs block inside that list item with consistent indentation
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-03-27T17:20:20.449Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/starlight-steps-tabs-structure.mdc:0-0
Timestamp: 2026-03-27T17:20:20.449Z
Learning: Applies to src/content/docs/**/*.mdx : In MDX documentation files, when `<Tabs>` is used inside a step, keep `<Tabs>`, `<TabItem>`, `</TabItem>`, and `</Tabs>` consistently nested under that step
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use `<Tabs syncKey="tech-stack">` to synchronize multi-language code selection across documentation pages
Applied to files:
src/components/templates/agent-connectors/_usage-googlecalendar.mdx
📚 Learning: 2026-03-12T05:02:13.454Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 487
File: src/content/docs/agent-auth/connections.mdx:0-0
Timestamp: 2026-03-12T05:02:13.454Z
Learning: In `src/content/docs/agent-auth/connections.mdx` (and Agent Auth docs in general), custom authentication (username/password/bearer-token flows) is intentionally out of scope for the current Agent Auth release. Do not flag the absence of custom authentication documentation in Agent Auth connection-type sections.
Applied to files:
src/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-12T05:02:13.454Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 487
File: src/content/docs/agent-auth/connections.mdx:0-0
Timestamp: 2026-03-12T05:02:13.454Z
Learning: In `src/content/docs/agent-auth/connections.mdx` (and Agent Auth docs generally), custom authentication (username/password/bearer-token flows) is intentionally out of scope for the current Agent Auth release. Do not flag the absence of custom authentication connection type documentation in Agent Auth connection-type sections.
Applied to files:
src/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-12T16:26:46.707Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:46.707Z
Learning: In `src/components/templates/agent-connectors/`, it is acceptable and intentional to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., `oauth-web-app.png`, `add-redirect-uri.png`) in other Google-service connector templates (e.g., `_setup-bigquery.mdx`, `_setup-google-ads.mdx`, etc.). Do not flag cross-connector image path reuse within the Google service connectors as an issue.
Applied to files:
src/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-13T03:51:44.897Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Applied to files:
src/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-03-31T16:14:24.575Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: public/AGENTS.md:0-0
Timestamp: 2026-03-31T16:14:24.575Z
Learning: Use Scalekit official plugin for AI coding agents (Claude Code, GitHub Copilot, Codex, or Skills CLI/Windsurf/Cline) to reduce hallucinations and improve code generation accuracy
Applied to files:
src/content/docs/agentkit/quickstart.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Applied to files:
src/content/docs/agentkit/quickstart.mdx
🔇 Additional comments (3)
src/components/templates/agent-connectors/_setup-googlecalendar.mdx (1)
35-35: Clear and actionable connection-name guidance.This update correctly prevents slug-vs-name confusion and aligns setup instructions with runtime usage.
src/content/docs/agentkit/connectors/googlecalendar.mdx (1)
36-37: Good prerequisite callout before code examples.The added note sets the right expectation and should reduce setup/runtime mismatches.
src/components/templates/agent-connectors/_usage-googlecalendar.mdx (1)
13-13: > Likely an incorrect or invalid review comment.
|
@coderabbitai if everything looks good, please approve |
|
Tip For best results, initiate chat on the files or code changes.
Everything looks good. Approving! [approve] 🧠 Learnings used |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
src/content/docs/agentkit/connectors/outlook.mdx (1)
4-4:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winCorrect the CDN host for the connector icon.
The connector icon URL uses
cdn.scalekit.cloud, but it should usecdn.scalekit.com. All other connector files in this PR use the correct host.Based on learnings: For agent connector documentation files, use CDN URLs for connector logos with the host
https://cdn.scalekit.com/sk-connect/assets/provider-icons/. The correct host iscdn.scalekit.com, NOTcdn.scalekit.cloud.🔧 Proposed fix
-connectorIcon: https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/outlook.svg +connectorIcon: https://cdn.scalekit.com/sk-connect/assets/provider-icons/outlook.svg🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/agentkit/connectors/outlook.mdx` at line 4, Update the connectorIcon URL in the outlook.mdx doc to use the correct CDN host: change the host from "cdn.scalekit.cloud" to "cdn.scalekit.com" so the value becomes "https://cdn.scalekit.com/sk-connect/assets/provider-icons/outlook.svg"; edit the connectorIcon entry in src/content/docs/agentkit/connectors/outlook.mdx accordingly to match other connector files.src/content/docs/agentkit/connectors/granolamcp.mdx (1)
33-41:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winMove the connection prerequisite above the code examples block.
The “Before calling this connector…” prerequisite currently appears after the examples section, which weakens the step order for first-time readers.
Suggested reorder
-<details> -<summary>Code examples</summary> - -<UsageGranolamcpSection /> - -</details> - Before calling this connector from your code, create the Granola MCP connection in **AgentKit** > **Connections** and copy the exact **Connection name** from that connection into your code. The value in code must match the dashboard exactly. + +<details> +<summary>Code examples</summary> + +<UsageGranolamcpSection /> + +</details>As per coding guidelines: "Include prerequisites before instructions in procedural documentation".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/agentkit/connectors/granolamcp.mdx` around lines 33 - 41, Move the prerequisite paragraph that begins "Before calling this connector..." so it appears above the code examples block; specifically, relocate that paragraph to precede the <details> block containing <UsageGranolamcpSection />. Ensure the text references creating the Granola MCP connection in AgentKit > Connections and copying the exact Connection name remains unchanged, so the prerequisite now appears before the UsageGranolamcpSection examples.src/components/templates/agent-connectors/_usage-googlecalendar.mdx (1)
220-224:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd the trailing
## Scalekit Toolsheading.This usage template is missing the
## Scalekit Toolsstructural anchor heading that other_usage-*.mdxtemplates include at the end. This heading is used by the parent connector reference page to append the tool-list section beneath the proxy API examples.Suggested fix
print(result) ``` </TabItem> </Tabs> + +## Scalekit ToolsBased on learnings: "the trailing
## Scalekit Toolsheading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_usage-googlecalendar.mdx` around lines 220 - 224, Add the missing trailing "## Scalekit Tools" heading at the end of this usage template so the parent connector reference page can append the tool-list; specifically, after the closing Tabs block (the closing </TabItem></Tabs> that follows the final code block containing print(result)), insert a standalone "## Scalekit Tools" heading line to match the other _usage-*.mdx templates.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/agentkit/connectors/github.mdx`:
- Around line 36-37: Replace the incorrect product casing "Github" with the
official "GitHub" in the connector docs: update the sentence that reads "create
the Github connection in **AgentKit** > **Connections**" (and any other
occurrences in src/content/docs/agentkit/connectors/github.mdx, e.g., the phrase
containing "Connection name") to use "GitHub" so the dashboard/product naming is
consistent across docs.
---
Outside diff comments:
In `@src/components/templates/agent-connectors/_usage-googlecalendar.mdx`:
- Around line 220-224: Add the missing trailing "## Scalekit Tools" heading at
the end of this usage template so the parent connector reference page can append
the tool-list; specifically, after the closing Tabs block (the closing
</TabItem></Tabs> that follows the final code block containing print(result)),
insert a standalone "## Scalekit Tools" heading line to match the other
_usage-*.mdx templates.
In `@src/content/docs/agentkit/connectors/granolamcp.mdx`:
- Around line 33-41: Move the prerequisite paragraph that begins "Before calling
this connector..." so it appears above the code examples block; specifically,
relocate that paragraph to precede the <details> block containing
<UsageGranolamcpSection />. Ensure the text references creating the Granola MCP
connection in AgentKit > Connections and copying the exact Connection name
remains unchanged, so the prerequisite now appears before the
UsageGranolamcpSection examples.
In `@src/content/docs/agentkit/connectors/outlook.mdx`:
- Line 4: Update the connectorIcon URL in the outlook.mdx doc to use the correct
CDN host: change the host from "cdn.scalekit.cloud" to "cdn.scalekit.com" so the
value becomes
"https://cdn.scalekit.com/sk-connect/assets/provider-icons/outlook.svg"; edit
the connectorIcon entry in src/content/docs/agentkit/connectors/outlook.mdx
accordingly to match other connector files.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: c8a4036d-b0c7-482b-9fdb-55721b8e24f0
📒 Files selected for processing (97)
scripts/sync-agent-connectors.jssrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-hubspot.mdxsrc/components/templates/agent-connectors/_setup-slack.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/components/templates/agent-connectors/_usage-exa.mdxsrc/components/templates/agent-connectors/_usage-gmail.mdxsrc/components/templates/agent-connectors/_usage-googlecalendar.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/components/templates/agent-connectors/_usage-phantombuster.mdxsrc/configs/redirects.config.tssrc/content/docs/agentkit/connectors/affinity.mdxsrc/content/docs/agentkit/connectors/airtable.mdxsrc/content/docs/agentkit/connectors/apifymcp.mdxsrc/content/docs/agentkit/connectors/apollo.mdxsrc/content/docs/agentkit/connectors/asana.mdxsrc/content/docs/agentkit/connectors/attio.mdxsrc/content/docs/agentkit/connectors/bigquery.mdxsrc/content/docs/agentkit/connectors/bigqueryserviceaccount.mdxsrc/content/docs/agentkit/connectors/bitbucket.mdxsrc/content/docs/agentkit/connectors/box.mdxsrc/content/docs/agentkit/connectors/brave.mdxsrc/content/docs/agentkit/connectors/calendly.mdxsrc/content/docs/agentkit/connectors/clickup.mdxsrc/content/docs/agentkit/connectors/close.mdxsrc/content/docs/agentkit/connectors/confluence.mdxsrc/content/docs/agentkit/connectors/databricksworkspace.mdxsrc/content/docs/agentkit/connectors/diarize.mdxsrc/content/docs/agentkit/connectors/discord.mdxsrc/content/docs/agentkit/connectors/dropbox.mdxsrc/content/docs/agentkit/connectors/dynamo.mdxsrc/content/docs/agentkit/connectors/evertrace.mdxsrc/content/docs/agentkit/connectors/exa.mdxsrc/content/docs/agentkit/connectors/figma.mdxsrc/content/docs/agentkit/connectors/freshdesk.mdxsrc/content/docs/agentkit/connectors/github.mdxsrc/content/docs/agentkit/connectors/gitlab.mdxsrc/content/docs/agentkit/connectors/gmail.mdxsrc/content/docs/agentkit/connectors/gong.mdxsrc/content/docs/agentkit/connectors/google_ads.mdxsrc/content/docs/agentkit/connectors/googlecalendar.mdxsrc/content/docs/agentkit/connectors/googledocs.mdxsrc/content/docs/agentkit/connectors/googledrive.mdxsrc/content/docs/agentkit/connectors/googleforms.mdxsrc/content/docs/agentkit/connectors/googlemeet.mdxsrc/content/docs/agentkit/connectors/googlesheets.mdxsrc/content/docs/agentkit/connectors/googleslides.mdxsrc/content/docs/agentkit/connectors/granola.mdxsrc/content/docs/agentkit/connectors/granolamcp.mdxsrc/content/docs/agentkit/connectors/harvestapi.mdxsrc/content/docs/agentkit/connectors/heyreach.mdxsrc/content/docs/agentkit/connectors/hubspot.mdxsrc/content/docs/agentkit/connectors/intercom.mdxsrc/content/docs/agentkit/connectors/jiminny.mdxsrc/content/docs/agentkit/connectors/jira.mdxsrc/content/docs/agentkit/connectors/linear.mdxsrc/content/docs/agentkit/connectors/linkedin.mdxsrc/content/docs/agentkit/connectors/microsoftexcel.mdxsrc/content/docs/agentkit/connectors/microsoftteams.mdxsrc/content/docs/agentkit/connectors/microsoftword.mdxsrc/content/docs/agentkit/connectors/miro.mdxsrc/content/docs/agentkit/connectors/monday.mdxsrc/content/docs/agentkit/connectors/notion.mdxsrc/content/docs/agentkit/connectors/onedrive.mdxsrc/content/docs/agentkit/connectors/onenote.mdxsrc/content/docs/agentkit/connectors/outlook.mdxsrc/content/docs/agentkit/connectors/outreach.mdxsrc/content/docs/agentkit/connectors/pagerduty.mdxsrc/content/docs/agentkit/connectors/parallelaitaskmcp.mdxsrc/content/docs/agentkit/connectors/phantombuster.mdxsrc/content/docs/agentkit/connectors/pipedrive.mdxsrc/content/docs/agentkit/connectors/posthogmcp.mdxsrc/content/docs/agentkit/connectors/salesforce.mdxsrc/content/docs/agentkit/connectors/servicenow.mdxsrc/content/docs/agentkit/connectors/sharepoint.mdxsrc/content/docs/agentkit/connectors/slack.mdxsrc/content/docs/agentkit/connectors/snowflake.mdxsrc/content/docs/agentkit/connectors/snowflakekeyauth.mdxsrc/content/docs/agentkit/connectors/supadata.mdxsrc/content/docs/agentkit/connectors/tableau.mdxsrc/content/docs/agentkit/connectors/twitter.mdxsrc/content/docs/agentkit/connectors/vercel.mdxsrc/content/docs/agentkit/connectors/vimeo.mdxsrc/content/docs/agentkit/connectors/youtube.mdxsrc/content/docs/agentkit/connectors/zendesk.mdxsrc/content/docs/agentkit/connectors/zoom.mdxsrc/content/docs/agentkit/examples/anthropic.mdxsrc/content/docs/agentkit/examples/google-adk.mdxsrc/content/docs/agentkit/examples/langchain.mdxsrc/content/docs/agentkit/examples/openai.mdxsrc/content/docs/agentkit/examples/vercel-ai.mdxsrc/content/docs/agentkit/quickstart.mdxsrc/content/docs/agentkit/sdks/node/index.mdxsrc/content/docs/agentkit/sdks/python/index.mdxsrc/content/docs/agentkit/tools/agent-tools-quickstart.mdxsrc/content/docs/agentkit/tools/scalekit-optimized-tools.mdxsrc/content/docs/authenticate/set-up-scalekit.mdx
2 participants
Update the AgentKit examples page title and sidebar label from "Examples" to "AgentKit code samples".
Summary by CodeRabbit